////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (c) 2010 Leon Coto Rodriguez
//  leoncoto@gmail.com
//  
//  Permission is hereby granted, free of charge, to any person
//  obtaining a copy of this software and associated documentation
//  files (the "Software"), to deal in the Software without
//  restriction, including without limitation the rights to use,
//  copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following
//  conditions:
//  
//   The above copyright notice and this permission notice shall be
//   included in all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
//  OTHER DEALINGS IN THE SOFTWARE.
//
////////////////////////////////////////////////////////////////////////////////
package org.flexspeedup.model
{
import mx.collections.IList;
[Bindable]
/**
 * Classes implementing this interface provide an way to manipulate data 
 * as a collection
 */
public interface IListModel
{

    //--------------------------------------------------------------------------
    //
    //  Properties
    //
    //--------------------------------------------------------------------------
   
    //--------------------------------
    // selectedItem
    //--------------------------------
    /**
     * The selected item in the collection
     */
    function get selectedItem():Object;
    function set selectedItem(value:Object):void;

    //--------------------------------
    // selectedItems
    //--------------------------------
    /**
     * The selected items in the collection.
     */
    function get selectedItems():IList;
    function set selectedItems(value:IList):void;

    //--------------------------------
    // dataProvider
    //--------------------------------
    /**
     * The actual data in the IListModel
     */
    function get dataProvider():IList /* of IListOption */;
    function set dataProvider(value:IList /* of IListOption */):void;

    //--------------------------------
    // resultSet
    //--------------------------------
    /**
     * <code>IResultSet</code> instance to provide aditional pagination support
     */
    function get resultSet():IResultSet;
    function set resultSet(value:IResultSet):void;

    //--------------------------------------------------------------------------
    //
    //  Methods
    //
    //--------------------------------------------------------------------------

    //----------------------------------
    //  reset
    //----------------------------------
    /**
     * Resets all the data in this model
     */
    function reset():void;
}
}